HubSpot API Documentation.md

CMS Performance

The CMS Performance API enables teams to monitor their HubSpot hosted pages for issues that may impact the experience of visitors on the website. These metrics include things like uptime, status, 1xx- 5xx errors, cache hits, total requests, and median response times, making it easy for administrators to take action quickly in the event of a problem.

Please note that metrics may not be updated in real-time, as there may be a 20-30 minute delay in the data.

This data is purged over time, depending on the resolution of the data:

1 minute - 5 minutes: purged after 1 week 10 minutes - 30 minutes: purged after 1 month 1 hour - 12 hours: purged after 6 months 1 day - 1 week: purged after 2 years

Example use case: You want to pull a list of pages that are resulting in 404 errors.

Endpoints

GET /cms/v3/performance/

View your website's performance. Returns time series data website performance data for the given domain and/or path.

Requirements

Scopes	None
Limits	Standard API rate limits

Parameters

domainStringQuery param

The domain to search return data for.

+ Set test value

pathStringQuery param

The url path of the domain to return data for.

+ Set test value

padBooleanQuery param

Specifies whether the time series data should have empty intervals if performance data is not present to create a continuous set.

+ Set test value

SAMPLE JSON RESPONSE

{
  "data": [
    {
      "403": 0,
      "404": 0,
      "500": 0,
      "504": 0,
      "startTimestamp": 0,
      "endTimestamp": 0,
      "startDatetime": "string",
      "endDatetime": "string",
      "totalRequests": 0,
      "cacheHits": 0,
      "cacheHitRate": 0,
      "totalRequestTime": 0,
      "avgOriginResponseTime": 0,
      "responseTimeMs": 0,
      "100X": 0,
      "20X": 0,
      "30X": 0,
      "40X": 0,
      "50X": 0,
      "50th": 0,
      "95th": 0,
      "99th": 0
    }
  ],
  "domain": "string",
  "path": "string",
  "startInterval": 0,
  "endInterval": 0,
  "interval": "ONE_MINUTE",
  "period": "ONE_MINUTE"
}

Error Response

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}